1 /*
2 * Scope: a generic MVC framework.
3 * Copyright (c) 2000-2002, The Scope team
4 * All rights reserved.
5 *
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * Neither the name "Scope" nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 *
36 * $Id: StringConvertor.java,v 1.4 2002/09/05 15:41:47 ludovicc Exp $
37 */
38 package org.scopemvc.util.convertor;
39
40 /***
41 * Specifies contract for all classes converting object values to <code>String</code>
42 * representation and back from <code>String</code> into object instances.
43 * Convertors should be based on <code>Locale</code>. <p>
44 *
45 * Default <code>StringConvertor</code>s can be obtained with class <code>StringConvertors</code>
46 * .
47 *
48 * @author <A HREF="mailto:danmi@users.sourceforge.net">Daniel Michalik</A>
49 * @created 05 September 2002
50 * @see StringConvertors
51 * @version $Revision: 1.4 $ $Date: 2002/09/05 15:41:47 $
52 */
53 public interface StringConvertor {
54
55 /***
56 * Formats object into <code>String</code>. It never return a null.
57 * Implementing class can offer posibility to set string representation of
58 * <code>null</code> (such as <code>"null"</code> or <code>"<null>"</code>),
59 * however default representation should be <code>""</code>. Slightly
60 * different null handling is performed in {@link StringStringConvertor
61 * StringStringConvertor} class.
62 *
63 * @param inValue TODO: Describe the Parameter
64 * @return TODO: Describe the Return Value
65 * @exception IllegalArgumentException this convertor can't express the
66 * value as String.
67 */
68 public String valueAsString(Object inValue) throws IllegalArgumentException;
69
70
71 /***
72 * Parses <code>String</code> to produce corresponding object. Empty or
73 * <code>null</code> string will be typically converted into <code>null</code>
74 * (unlike standard <code>java.text</code> formats which throws exceptions
75 * in such situations).
76 *
77 * @param inString TODO: Describe the Parameter
78 * @return TODO: Describe the Return Value
79 * @exception IllegalArgumentException can't convert from String.
80 */
81 public Object stringAsValue(String inString) throws IllegalArgumentException;
82
83 }
84
This page was automatically generated by Maven